No Current Link To VocabularyCoded With ExtensionsCoded No Extensions
MFMI_HD700751CA
Registry Query Request Wrapper - Human Initiated

(Link to Excel View)
Derived from RMIM: MFMI_RM700751CA
 
ControlActEvent

Design Comments: Identifies the action that resulted in this message being sent.

UsageNotes: There may be constraints on the usage of the effectiveTime and reasonCode attributes in the definition of the interaction or the trigger events which are conveyed with this wrapper.

Rationale: Key to understanding what action a message represents.

classCode [1..1] (M)
ControlAct (CS) {CNE:C:ActClass:CACT, fixed value= "CACT"}
moodCode [1..1] (M)
ControlAct (CS) {CNE:C:ActMood:EVN, fixed value= "EVN"}
id [1..1] (M)
ControlAct (II.BUS)

Design Comments: A unique identifier for this particular event assigned by the system in which the event occurred.

UsageNotes: Identifier needs to be persisted by receiving applications, except for queries (queries cannot be retracted or undone). The identifier must be unique and different from the event identifier that is present on the request - it must be generated by the responding application.

Rationale: Allows the event to be referenced (for undos) and also indicates whether multiple interactions were caused by the same triggering event. Also used for audit purposes.

code [1..1] (M)
ControlAct (CV) {CNE:D:HL7TriggerEventCode}

Design Comments: Identifies the trigger event that occurred.

Rationale: This is mandatory because it is essential to understanding the meaning of the event.

statusCode [1..1] (M)
ControlAct (CS) {CNE:C:ActStatus:completed, fixed value= "completed"}

Design Comments: Describes the status of the control act, which is always complete (it happened).

Rationale: Required for completeness of specification.

effectiveTime [0..1]
ControlAct (IVL<TS.FULLDATEWITHTIME>)

Design Comments: Indicates the time the event (e.g. query, change, activation) should begin and occasionally when it should end.

Rationale: The time an event becomes effective may differ from the time the event is recorded (i.e. it may be in the future or the past). For events such as 'suspend', an intended end date may also be indicated.

reasonCode [0..1]
ControlAct (CV) {CWE:D:ControlActReason}

Design Comments: Identifies why this specific message interaction (e.g. query, activation request, modification request) occurred.

UsageNotes: The domain associated with this attribute will vary for each interaction and will be noted as part of the interaction description.

Rationale: Allows identifying a reason for a specific action, such as 'reason for hold' or 'reason for accessing information'.

languageCode [0..1]
ControlAct (CE) {CNE:D:HumanLanguage}
responsibleParty [0..1] (ResponsibleParty)

Design Comments: Allows for the trail of responsibility for the action. The association is optional because in some jurisdictions, the supervisor may be conveyed by he authentication token.

Rationale: Important for audit information and determining permissions.

The association is optional because in some jurisdictions this information will be conveyed as part of the authentication token

author [1..1] (Author)

Design Comments: Indicates the person responsible for the event that caused this message.

Rationale: Critical for auditing and for validating permissions and therefore mandatory.

dataEnterer [0..1] (DataEnterer)

Design Comments: Indicates the person responsible for entering the query into the system. Used when different from the person responsible for the request (author). For example, physician requests administrative assistant to print off a patient's medication profile.

UsageNotes: This should only be specified if different from the author.

Rationale: Important for audit information and determining permissions.

The association is optional because in some jurisdictions this information will be conveyed as part of the authentication token.

dataEntryLocation [0..1] (DataEntryLocation)

Design Comments: Indicates the location where the record of this event was entered.

UsageNotes: This should only be specified if different from the location where the event was authored.

Rationale: Indicates a potential location for written records, and may also be important for authentication purposes.

The association is optional because in some jurisdictions this information will be conveyed as part of the authentication token.

location [0..1] (Location)

Design Comments: Indicates the service delivery location where the event occurred.

Rationale: Indicates where paper records may be located, and may be important to determining authorization.

The association is optional because in some jurisdictions this information will be conveyed as part of the authentication token.

pertinentInformation [0..1] (PertinentInformation)

Design Comments: Identifies the authentication token that references information about the people and/or places responsible for the event.

Rationale: Some systems perform centralized authentication of providers and/or locations. The association is optional because not all systems will make use of a token-based authentication process.

subjectOf1 [0..1] (Subject1)

Design Comments: Information pertaining to a client's agreement/acceptance to have his/her client identification and demographic information electronically stored and shared.

UsageNotes: This will usually only be populated for queries, but could be used for updates if a jurisdiction requires consent before recording information in the EHR (e.g. consent to participate in electronic data exchange).

Note: keywords canot be passed from one application to another via the EHR (e.g. prescriber to dispenser via a Drug Information System).

Rationale: Provides authorization to record and/or view client information.

Indicates the consent or keyword used to authorize access or update, including a reason for access; May also be used to override access restriction to the information ('break the glass') on a message by message basis.

subjectOf2 [0..50] (Subject2)

Design Comments: This is the list of clinical and business issues that have been detected and/or managed involving the current action.

Rationale: Any trigger event can result in errors or may allow for errors to be overridden or managed.

queryByParameter [1..1] (QueryByParameter)

Design Comments: Class which describes the query specifics and parameter list.

 
ResponsibleParty
[Constraint: "

If AuthorizationToken not specified, association is mandatory. If AuthorizationToken specified, association is mandatory if authorization does not cover this participation.

"]

Design Comments: Allows for the trail of responsibility for the action. The association is optional because in some jurisdictions, the supervisor may be conveyed by he authentication token.

Rationale: Important for audit information and determining permissions.

The association is optional because in some jurisdictions this information will be conveyed as part of the authentication token

typeCode [1..1] (M)
Participation (CS) {CNE:C:ParticipationType:RESP, fixed value= "RESP"}
contextControlCode [1..1] (M)
Participation (CS) {CNE:C:ContextControl:AP, fixed value= "AP"}
assignedPerson [1..1] (R_AssignedPersonIdentified-confirmable)
 
Author
[Constraint: "

If AuthorizationToken is specified and communicates author, the bare AuthorRole class must be specified, otherwise (R_AssignedPerson CMET or R_AssignedOrganization) must be specified.

"]

Design Comments: Indicates the person responsible for the event that caused this message.

Rationale: Critical for auditing and for validating permissions and therefore mandatory.

typeCode [1..1] (M)
Participation (CS) {CNE:C:ParticipationType:AUT, fixed value= "AUT"}

UsageNotes: Value should always be AUT

contextControlCode [1..1] (M)
Participation (CS) {CNE:C:ContextControl:AP, fixed value= "AP"}
time [1..1] (M)
Participation (TS.FULLDATETIME)

Design Comments: The time the person responsible for the event made the decision for it to occur. This may be different than the time the change became effective. (E.g. If a provider decides today to put a prescription on hold starting next Tuesday, the time of creation would be today and the change effective period would be next Tuesday.)

This date can be back-dated.

Rationale: The time a change is made is a critical piece of audit information and is therefore mandatory.

modeCode [0..1]
Participation (CV) {CNE:D:ParticipationMode}

Design Comments: Indicates how the person who recorded the event became aware of it.. E.g. Verbal, written, fax, etc.

Rationale: May have ramifications for the audit trail and reliability of the information.

signatureText [0..1]
Participation (ED.SIGNATURE)

Design Comments: Indicates the formal digital signature of the message content.

Rationale: Digital signatures may be needed for authentication of message content. The attribute is marked as optional because it is not yet clear whether there is a use-case for this, or where it will be used.

authorPerson [1..1] (AuthorPerson)
 
AuthorPerson
choice of AuthorRole

Design Comments: This is a messaging artifact used by HL7 to allow the time, signiture and method to be captured when the author is not sent. This will happen in circumstances where the author information is sent as part of the authentication token.

          or R_AssignedPersonIdentified-confirmable
          or R_AssigningOrganizationIdentified-confirmable
 
AuthorRole

Design Comments: This is a messaging artifact used by HL7 to allow the time, signiture and method to be captured when the author is not sent. This will happen in circumstances where the author information is sent as part of the authentication token.

classCode [1..1] (M)
Role (CS) {CNE:C:RoleClass:ROL, fixed value= "ROL"}
 
DataEnterer
[Constraint: "

If AuthorizationToken not specified, association is mandatory. If AuthorizationToken specified, association is mandatory if authorization does not cover this participation.

"]

Design Comments: Indicates the person responsible for entering the query into the system. Used when different from the person responsible for the request (author). For example, physician requests administrative assistant to print off a patient's medication profile.

UsageNotes: This should only be specified if different from the author.

Rationale: Important for audit information and determining permissions.

The association is optional because in some jurisdictions this information will be conveyed as part of the authentication token.

typeCode [1..1] (M)
Participation (CS) {CNE:C:ParticipationType:ENT, fixed value= "ENT"}
contextControlCode [1..1] (M)
Participation (CS) {CNE:C:ContextControl:AP, fixed value= "AP"}
entererChoice [1..1] (EntererChoice)
 
EntererChoice
choice of R_AssignedPersonIdentified-confirmable
          or R_AssigningOrganizationIdentified-confirmable
 
DataEntryLocation
[Constraint: "

If AuthorizationToken not specified, association is mandatory. If AuthorizationToken specified, association is mandatory if authorization does not cover this participation.

"]

Design Comments: Indicates the location where the record of this event was entered.

UsageNotes: This should only be specified if different from the location where the event was authored.

Rationale: Indicates a potential location for written records, and may also be important for authentication purposes.

The association is optional because in some jurisdictions this information will be conveyed as part of the authentication token.

typeCode [1..1] (M)
Participation (CS) {CNE:C:ParticipationType:ELOC, fixed value= "ELOC"}
contextControlCode [1..1] (M)
Participation (CS) {CNE:C:ContextControl:AP, fixed value= "AP"}
serviceDeliveryLocation [1..1] (R_ServiceDeliveryLocationMinimal)
 
Location
[Constraint: "

If AuthorizationToken not specified, association is required. If AuthorizationToken specified, association is required if authorization does not cover this participation.

"]

Design Comments: Indicates the service delivery location where the event occurred.

Rationale: Indicates where paper records may be located, and may be important to determining authorization.

The association is optional because in some jurisdictions this information will be conveyed as part of the authentication token.

typeCode [1..1] (M)
Participation (CS) {CNE:C:ParticipationType:LOC, fixed value= "LOC"}
contextControlCode [1..1] (M)
Participation (CS) {CNE:C:ContextControl:AP, fixed value= "AP"}
serviceDeliveryLocation [1..1] (R_ServiceDeliveryLocationMinimal)
 
PertinentInformation

Design Comments: Identifies the authentication token that references information about the people and/or places responsible for the event.

Rationale: Some systems perform centralized authentication of providers and/or locations. The association is optional because not all systems will make use of a token-based authentication process.

typeCode [1..1] (M)
ActRelationship (CS) {CNE:C:ActRelationshipType:PERT, fixed value= "PERT"}
contextControlCode [1..1] (M)
ActRelationship (CS) {CNE:C:ContextControl:AP, fixed value= "AP"}
contextConductionInd [1..1] (M)
ActRelationship (BL){fixed value= "false"}
authorizationToken [1..1] (AuthorizationToken)

Design Comments: Conveys an authentication token associated with the event.

The token may represent one or all of the following concepts: author, dataEnterer, responsibleParty, location and dataEntryLocation.

Rationale: Conveys information related to the individuals and/or locations involved with the action in situations where the authentication happens on a one-time basis rather than on a per-message basis.

 
AuthorizationToken
[Constraint: "

If specified, then the concepts covered by the token must not be specified (i.e. at least one participation of author, dataEnterer, responsibleParty, location and dataEntryLocation must not be specified)

"]

[Constraint: "

Only one of Id or Text must be specified.

"]

Design Comments: Conveys an authentication token associated with the event.

The token may represent one or all of the following concepts: author, dataEnterer, responsibleParty, location and dataEntryLocation.

Rationale: Conveys information related to the individuals and/or locations involved with the action in situations where the authentication happens on a one-time basis rather than on a per-message basis.

classCode [1..1] (M)
Observation (CS) {CNE:C:ActClass:VERIF, fixed value= "VERIF"}
moodCode [1..1] (M)
Observation (CS) {CNE:C:ActMood:EVN, fixed value= "EVN"}
id [0..1]
Observation (II.TOKEN)

Design Comments: An authorization token expressed as a GUID.

The Authorization token may represent the concepts of author, data enterer, supervisor (responsible party), responsible location and/or data entry location.

Rationale: GUIDs are an effective way of conveying a temporary authentication token

text [0..1]
Observation (ST)

Design Comments: An authentication token expressed as a non-GUID string.

The Authorization token may represent the concepts of author, data enterer, supervisor (responsible party), responsible location and/or data entry location.

Rationale: Some systems may choose to use a hashcode or other approach to token construction.

 
Subject1

Design Comments: Information pertaining to a client's agreement/acceptance to have his/her client identification and demographic information electronically stored and shared.

UsageNotes: This will usually only be populated for queries, but could be used for updates if a jurisdiction requires consent before recording information in the EHR (e.g. consent to participate in electronic data exchange).

Note: keywords canot be passed from one application to another via the EHR (e.g. prescriber to dispenser via a Drug Information System).

Rationale: Provides authorization to record and/or view client information.

Indicates the consent or keyword used to authorize access or update, including a reason for access; May also be used to override access restriction to the information ('break the glass') on a message by message basis.

typeCode [1..1] (M)
ActRelationship (CS) {CNE:C:ActRelationshipType:SUBJ, fixed value= "SUBJ"}
contextControlCode [1..1] (M)
ActRelationship (CS) {CNE:C:ContextControl:AP, fixed value= "AP"}
contextConductionInd [1..1] (M)
ActRelationship (BL){fixed value= "false"}
consentEventRegistry [1..1] (A_ConsentEventRegistryBasic)
 
Subject2

Design Comments: This is the list of clinical and business issues that have been detected and/or managed involving the current action.

Rationale: Any trigger event can result in errors or may allow for errors to be overridden or managed.

typeCode [1..1] (M)
ActRelationship (CS) {CNE:C:ActRelationshipType:SUBJ, fixed value= "SUBJ"}
contextControlCode [1..1] (M)
ActRelationship (CS) {CNE:C:ContextControl:AP, fixed value= "AP"}
contextConductionInd [1..1] (M)
ActRelationship (BL){fixed value= "false"}
issueEvent [1..1] (A_IssueEventManaged-basic)
 
QueryByParameter
[Constraint: "

InitialQuantity must only be specified if InitialQuantityCode is specified.

"]

Design Comments: Class which describes the query specifics and parameter list.

queryId [1..1] (M)
QueryByParameter (II.TOKEN)

Design Comments: Unique number for this particular query.

Rationale: Needed to allow continuation of queries and linking of query requests and responses and therefore mandatory.

responseModalityCode [0..1]
QueryByParameter (CS) {CNE:D:ResponseModality}

Design Comments: This allows the sender to indicate to the receiver that this query should follow an expedited processing flow.

Rationale: Intended to convey the requested 'packaging' of query results. This attribute does not affect which rows are selected by the query, just the manner in which they are returned. For example, a batch file containing responses, a response message containing multiple payloads, or a stream of response messages (notifications) each identifying itself as a response to a query request.

initialQuantity [0..1]
QueryByParameter (INT.POS)

Design Comments: The number of response item repetitions that should be included in the initial response.

UsageNotes: If not specified, the default behavior is to return all repetitions. However the recipient of a query may always choose to limit the quantity returned to be less than the number requested. Regardless of the number specified here, the number of rows returned will never exceed the number of matching rows based on the query parameters.

Rationale: There may be a very large number of matching rows. To manage communication bandwidth, a limited set may initially be returned with further data retrieved by using query continuations.

initialQuantityCode [0..1]
QueryByParameter (CV) {CNE:D:QueryRequestLimit}

Design Comments: Defines the units associated with the magnitude of the maximum size limit of a query response that can be accepted by the requesting application.

Rationale: Needed to quantify the types of records requested to be returned in the query.

parameterList [1..1] (Stub "ParameterList")
sortControl [0..10] (SortControl)

Design Comments: Holds specification of sort order for instance matches to a query.

Rationale: Optional for systems which can receive query requests and sort the results before returning to the query requestor.

 
SortControl
[Constraint: "

Please consult the implementation guide for further constraints on using this class

"]

Design Comments: Holds specification of sort order for instance matches to a query.

Rationale: Optional for systems which can receive query requests and sort the results before returning to the query requestor.

sequenceNumber [1..1] (M)
SortControl (INT.NONNEG)

Design Comments: When more than one sort control is specified, this is the order of this sort element amongst the others.

Rationale: This number determines which sort element is using primarily, secondary, etc. and is therefore mandatory.

elementName [1..1] (M)
SortControl (ST)

Design Comments: Name of the element to sort.

Rationale: The name of the element is mandatory.

directionCode [0..1]
SortControl (CS) {CNE:D:Sequencing}

Design Comments: Sets the ascending or descending nature of the sort request.

Rationale: This element is required.